/*******************************************************************************
 * The MIT License
 * 
 * Copyright (c) 2011 David Waltermire
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 ******************************************************************************/
package org.scapdev.content.model;

/**
 * Represents an index field that is associated with an index key reference
 * within the XML schema meta model.
 * @see FieldRefType
 * @see org.scapdev.content.annotation.FieldRef
 */
public interface FieldRefInfo extends IndexFieldInfo {
	/**
	 * Retrieves the key reference type associated with this field reference
	 * type
	 * 
	 * @return the key reference information associated with this field
	 *         reference type
	 */
	KeyRefInfo getKeyRefInfo();

	/**
	 * Retrieves information about the index field that is associated with this
	 * field reference type.
	 * 
	 * @return the field information referenced by this field reference type
	 */
	FieldInfo getReferencedFieldInfo();
}
